home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / librw / RWTValHashDictionaryIterator.z / RWTValHashDictionaryIterator
Encoding:
Text File  |  1998-10-30  |  5.4 KB  |  133 lines
  1.  
  2.  
  3.  
  4. RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))          RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))
  5.  
  6.  
  7.  
  8. NNNNaaaammmmeeee
  9.      RWTValHashDictionaryIterator<K,V> - Rogue Wave library class
  10.  
  11. SSSSyyyynnnnooooppppssssiiiissss
  12.               #include <rw/tvhdict.h>
  13.  
  14.  
  15.  
  16.               unsigned hashFun(const K&);
  17.           RWTValHashDictionary<K,V> dictionary(hashFun);
  18.           RWTValHashDictonaryIterator<K,V> iterator(dictionary);
  19.  
  20. PPPPlllleeeeaaaasssseeee NNNNooootttteeee!!!!
  21.      IIIIffff yyyyoooouuuu ddddoooo nnnnooootttt hhhhaaaavvvveeee tttthhhheeee SSSSttttaaaannnnddddaaaarrrrdddd CCCC++++++++ LLLLiiiibbbbrrrraaaarrrryyyy,,,, uuuusssseeee tttthhhheeee iiiinnnntttteeeerrrrffffaaaacccceeee ddddeeeessssccccrrrriiiibbbbeeeedddd
  22.      hhhheeeerrrreeee....  OOOOtttthhhheeeerrrrwwwwiiiisssseeee,,,, uuuusssseeee tttthhhheeee iiiinnnntttteeeerrrrffffaaaacccceeee ttttoooo RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr described in
  23.      the Class Reference.
  24.  
  25.  
  26. DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
  27.      Iterator for class RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyy<<<<KKKK,,,,VVVV>>>>, allowing sequential access
  28.      to all keys and values of a parameterized hash dictionary.  Elements are
  29.      not accessed in any particular order.  Like all Rogue Wave iterators, the
  30.      "current item" is undefined immediately after construction -- you must
  31.      define it by using ooooppppeeeerrrraaaattttoooorrrr(((()))) or some other (valid) operation.  Once the
  32.      iterator has advanced beyond the end of the collection it is no longer
  33.      valid -- continuing to use it will bring undefined results.
  34.  
  35. PPPPeeeerrrrssssiiiisssstttteeeennnncccceeee
  36.      None
  37.  
  38. PPPPuuuubbbblllliiiicccc CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  39.               RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr(RWTValHashDictionary& c);
  40.  
  41.  
  42.      Constructs an iterator to be used with the dictionary cccc.
  43.  
  44.  
  45.  
  46.  
  47.  
  48. PPPPuuuubbbblllliiiicccc OOOOppppeeeerrrraaaattttoooorrrrssss
  49.               RWBoolean
  50.           ooooppppeeeerrrraaaattttoooorrrr++++++++();
  51.  
  52.  
  53.      Advances the iterator one position.  Returns TTTTRRRRUUUUEEEE if the new position is
  54.      valid, FFFFAAAALLLLSSSSEEEE otherwise.
  55.  
  56.               RWBoolean
  57.           ooooppppeeeerrrraaaattttoooorrrr(((())))();
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))          RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))
  71.  
  72.  
  73.  
  74.      Advances the iterator one position.  Returns TTTTRRRRUUUUEEEE if the new position is
  75.      valid, FFFFAAAALLLLSSSSEEEE otherwise.
  76.  
  77. PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss
  78.               RWTValHashDictionary*
  79.           ccccoooonnnnttttaaaaiiiinnnneeeerrrr() const;
  80.  
  81.  
  82.      Returns a pointer to the collection over which this iterator is
  83.      iterating.
  84.  
  85.               K
  86.           kkkkeeeeyyyy() const;
  87.  
  88.  
  89.      Returns the key at the iterator's current position.  The results are
  90.      undefined if the iterator is no longer valid.
  91.  
  92.               void
  93.           rrrreeeesssseeeetttt();
  94.  
  95.  
  96.      Resets the iterator to the state it had immediately after construction.
  97.  
  98.               void
  99.           rrrreeeesssseeeetttt(RWTValHashDictionary& c);
  100.  
  101.  
  102.      Resets the iterator to iterate over the collection cccc.
  103.  
  104.               V
  105.           vvvvaaaalllluuuueeee() const;
  106.  
  107.  
  108.      Returns the value at the iterator's current position.  The results are
  109.      undefined if the iterator is no longer valid.
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.